Skip to content

docs(experimentation): group warehouse pages under Connect a Warehouse - #8883

Merged
Zaimwa9 merged 16 commits into
mainfrom
docs/warehouse-pages
Nov 6, 2026
Merged

Zaimwa9 merged 16 commits into
mainfrom
docs/warehouse-pages

Conversation

@Zaimwa9

@Zaimwa9 Zaimwa9 commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Thanks for submitting a PR! Please check the boxes below:

  • I have read the Contributing Guide.
  • I have added information to docs/ if required so people know about the feature.
  • I have filled in the "Changes" section below.
  • I have filled in the "How did you test this code" section below.

Changes

Follows #8873. Groups the warehouse pages under Connect a Warehouse.

  • Connect a Warehouse becomes a sidebar category: the overview stays at /experimentation/connect-a-warehouse, with ClickHouse (moved out of the overview), Databricks and PostgreSQL as child pages.
  • Existing URLs keep working through slug front matter; ClickHouse is now at /experimentation/connect-clickhouse.
  • The ClickHouse page follows the Databricks and PostgreSQL layout: before you start, setup SQL, connect, manage and troubleshooting, with a form screenshot.
  • The Self-Hosting page shows how to enable the Flagsmith database with the Helm chart (api.extraEnv).
  • The docs parity tests read the new file paths.

How did you test this code?

Docs build with no new broken links, prettier, and the setup SQL docs parity tests.

@vercel

vercel Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Nov 6, 2026 12:27pm UTC
2 Skipped Deployments
Project Deployment Actions Updated
flagsmith-frontend-preview Ignored Ignored Preview Nov 6, 2026 12:27pm UTC
flagsmith-frontend-staging Ignored Ignored Preview Nov 6, 2026 12:27pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Explain Change →

Walkthrough

The documentation adds a ClickHouse warehouse connection guide and updates warehouse navigation, provider links and troubleshooting references. The Databricks guide limits first-event verification to Flagsmith Cloud. The self-hosting guide adds Helm guidance for enabling experimentation with only the Flagsmith database. A PostgreSQL documentation test now compares the SQL example with the generated onboarding SQL.

Estimated code review effort: 2 (Simple) | ~12 minutes

Merge Risk: Moderate · up to 50fa4

This is a documentation reorganization with working ClickHouse, Databricks and PostgreSQL pages. The Helm instructions for the Flagsmith database option omit the Flagsmith version it needs, so operators using the chart's default images cannot finish the setup. A few smaller documentation gaps also remain around PostgreSQL delivery versions, timestamp limits and schema naming. Fix the Helm version guidance before merging; the rest are low-risk follow-ups.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@Zaimwa9
Zaimwa9 marked this pull request as ready for review November 5, 2026 09:59
@Zaimwa9
Zaimwa9 requested review from a team as code owners November 5, 2026 09:59
@Zaimwa9
Zaimwa9 requested review from Holmus and kyle-ssg and removed request for a team November 5, 2026 09:59
@github-actions github-actions Bot removed the docs Documentation updates label Nov 5, 2026
@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Docker builds report

Image Build Status Security report
ghcr.io/flagsmith/flagsmith-api-test:pr-8883 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-e2e:pr-8883 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-api:pr-8883 Finished ✅ Results ✅
ghcr.io/flagsmith/flagsmith:pr-8883 Finished ✅ Results ✅
ghcr.io/flagsmith/flagsmith-private-cloud:pr-8883 Finished ✅ Results ✅
ghcr.io/flagsmith/flagsmith-frontend:pr-8883 Finished ✅ Results ✅

@github-actions github-actions Bot added the docs Documentation updates label Nov 5, 2026
@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor
✅ private-cloud · depot-ubuntu-latest-arm-16 — run #22916 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  3 passed

Details

stats  3 tests across 3 suites
duration  47.1 seconds
commit  50fa4be
info  🔄 Run: #22916 (attempt 1)

🗂️ Previous results
✅ private-cloud · depot-ubuntu-latest-16 — run #22916 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  32 seconds
commit  50fa4be
info  🔄 Run: #22916 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #22916 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  34.9 seconds
commit  50fa4be
info  🔄 Run: #22916 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #22916 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  32.2 seconds
commit  50fa4be
info  🔄 Run: #22916 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-16 — run #22892 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  57.5 seconds
commit  7b89137
info  🔄 Run: #22892 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-arm-16 — run #22892 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  38.6 seconds
commit  7b89137
info  🔄 Run: #22892 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #22892 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  36.8 seconds
commit  7b89137
info  🔄 Run: #22892 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #22892 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  31.5 seconds
commit  7b89137
info  🔄 Run: #22892 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-arm-16 — run #22890 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  3 passed

Details

stats  3 tests across 3 suites
duration  37.7 seconds
commit  193c6ca
info  🔄 Run: #22890 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-16 — run #22890 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  3 passed

Details

stats  3 tests across 3 suites
duration  34.1 seconds
commit  193c6ca
info  🔄 Run: #22890 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #22890 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  3 passed

Details

stats  3 tests across 3 suites
duration  32 seconds
commit  193c6ca
info  🔄 Run: #22890 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #22890 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  21 passed
skipped  1 skipped

Details

stats  22 tests across 14 suites
duration  1 minute, 10 seconds
commit  193c6ca
info  🔄 Run: #22890 (attempt 1)

Skipped tests

firefox › tests/onboarding-tests.pw.ts › Onboarding › New user connects via the single-page onboarding flow @oss

@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Visual Regression

24 screenshots compared. See report for details.
View full report

@github-actions github-actions Bot added docs Documentation updates and removed docs Documentation updates labels Nov 5, 2026
@Zaimwa9
Zaimwa9 requested review from gagantrivedi and removed request for Holmus and kyle-ssg November 5, 2026 11:14
@github-actions github-actions Bot added docs Documentation updates and removed docs Documentation updates labels Nov 5, 2026
gagantrivedi
gagantrivedi previously approved these changes Nov 6, 2026
Base automatically changed from docs/postgres-warehouse to main November 6, 2026 12:16
@Zaimwa9
Zaimwa9 dismissed gagantrivedi’s stale review November 6, 2026 12:16

The base branch was changed.

# Conflicts:
#	docs/docs/experimentation/connect-a-warehouse.md
#	docs/docs/experimentation/self-hosting.md
#	frontend/web/components/pages/environment-settings/tabs/warehouse-tab/__tests__/postgresSetupSqlDocs.test.ts

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

Review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 746acfc7-1632-432b-afe7-44aaf7febea3
Commits

Reviewing files that changed from the base of the PR and between a130da6 and 7b89137.

Files ignored due to path filters: 5

  • docs/static/img/experimentation/warehouse-clickhouse-form.png is excluded by !**/*.png
  • docs/static/img/experimentation/warehouse-flagsmith-database-connected.png is excluded by !**/*.png
  • docs/static/img/experimentation/warehouse-flagsmith-database.png is excluded by !**/*.png
  • docs/static/img/experimentation/warehouse-postgres-connected.png is excluded by !**/*.png
  • docs/static/img/experimentation/warehouse-postgres-form.png is excluded by !**/*.png
Files selected for processing: 17

  • docs/docs/deployment-self-hosting/core-configuration/environment-variables.md
  • docs/docs/deployment-self-hosting/hosting-guides/kubernetes-openshift.md
  • docs/docs/experimentation/connect-a-warehouse.md
  • docs/docs/experimentation/connect-a-warehouse/_category_.json
  • docs/docs/experimentation/connect-a-warehouse/clickhouse.md
  • docs/docs/experimentation/connect-a-warehouse/databricks.md
  • docs/docs/experimentation/connect-a-warehouse/index.md
  • docs/docs/experimentation/connect-a-warehouse/postgresql.md
  • docs/docs/experimentation/run-an-experiment.mdx
  • docs/docs/experimentation/self-hosting.md
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/WarehouseSetup.tsx
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/__tests__/clickhouseSetupSql.test.ts
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/__tests__/databricksSetupSqlDocs.test.ts
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/__tests__/postgresSetupSql.test.ts
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/__tests__/postgresSetupSqlDocs.test.ts
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/clickhouseSetupSql.ts
  • frontend/web/components/pages/environment-settings/tabs/warehouse-tab/postgresSetupSql.ts
Files with no reviewable changes: 1

  • docs/docs/experimentation/connect-a-warehouse.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

@github-actions github-actions Bot added docs Documentation updates and removed docs Documentation updates labels Nov 6, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Additional comments: 1

docs/docs/experimentation/connect-a-warehouse/index.md: 1

67-67: Minor · Functional Correctness · Quick win

Unverified finding
Verification ran but could not confirm this finding. It is shown for review, not as a verified issue.

Retain the former provider anchors.

The removed sections provided #bring-your-own-clickhouse and #bring-your-own-databricks. Existing links to those anchors now open the overview without reaching the provider links. Restore the anchors beside the corresponding links. (raw.githubusercontent.com)

The PR objective is to retain existing URLs.

Review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 00378920-fbaf-44a9-a3aa-ed65be97f8d4
Commits

Reviewing files that changed from the base of the PR and between 7b89137 and 50fa4be.

Files selected for processing: 4

  • docs/docs/experimentation/connect-a-warehouse/clickhouse.md
  • docs/docs/experimentation/connect-a-warehouse/index.md
  • docs/docs/experimentation/connect-a-warehouse/postgresql.md
  • docs/docs/experimentation/self-hosting.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 6 remain after this review.

@Zaimwa9
Zaimwa9 merged commit 6102623 into main Nov 6, 2026
32 checks passed
@Zaimwa9
Zaimwa9 deleted the docs/warehouse-pages branch November 6, 2026 12:31

This branch was successfully deployed

3 active (2 outdated) deployments
Preview – docs — 50fa4bee Deployed Nov 6, 2026 by vercel[bot]
Preview – flagsmith-frontend-preview — 72676a40 Deployed Nov 5, 2026 by vercel[bot]
Preview – flagsmith-frontend-staging — 72676a40 Deployed Nov 5, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation updates front-end Issue related to the React Front End Dashboard

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants